Skip to main content

Add-LoggingTarget

SYNOPSIS​

Enable a logging target

SYNTAX​

Add-LoggingTarget [[-Configuration] <Hashtable>] [-ProgressAction <ActionPreference>] -Type <String>
 [-UniqueName <String>] [<CommonParameters>]

DESCRIPTION​

This function configure and enable a logging target

EXAMPLES​

EXAMPLE 1​

Add-LoggingTarget -Name Console -Configuration @{Level = 'DEBUG'}

EXAMPLE 2​

Add-LoggingTarget -Type File -UniqueName 'ErrorsOnly' -Configuration @{Level = 'ERROR'; Path = 'C:\Temp\errors.log'}

EXAMPLE 3​

Add-LoggingTarget -Name File -Configuration @{Level = 'INFO'; Path = 'C:\Temp\script.log'}

EXAMPLE 4​

Add-LoggingTarget -Type File -UniqueName 'DatabaseLogs' -Configuration @{Level = 'INFO'; Path = 'C:\Logs\db.log'; Tags = @('Database', 'Performance')}

PARAMETERS​

-Configuration​

An hashtable containing the configurations for the target Can include a 'Tags' key with an array of strings for tag-based message routing

Type: Hashtable
Parameter Sets: (All)
Aliases:

Required: False
Position: 3
Default value: @{}
Accept pipeline input: False
Accept wildcard characters: False

-ProgressAction​

{{ Fill ProgressAction Description }}

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Type​

{{ Fill Type Description }}

Type: String
Parameter Sets: (All)
Aliases: Name

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-UniqueName​

{{ Fill UniqueName Description }}

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters​

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS​

OUTPUTS​

NOTES​

https://logging.readthedocs.io/en/latest/functions/Add-LoggingTarget.md

https://logging.readthedocs.io/en/latest/functions/Write-Log.md

https://logging.readthedocs.io/en/latest/AvailableTargets.md

https://github.com/EsOsO/Logging/blob/master/Logging/public/Add-LoggingTarget.ps1

EDIT THIS DOC​

This page was auto-generated from the powershell command comment based help. To edit the content of this page, update the script file comment based help on github Github